chore: improve trainer docstrings and contributing guide formatting#371
chore: improve trainer docstrings and contributing guide formatting#371VT69 wants to merge 1 commit intokubeflow:mainfrom
Conversation
…e readability Signed-off-by: VT <75622110+VT69@users.noreply.github.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
google-oss-prow
bot
requested review from
Electronic-Waste,
astefanutti and
szaher
|
🎉 Welcome to the Kubeflow SDK! 🎉 Thanks for opening your first PR! We're happy to have you as part of our community 🚀 Here's what happens next:
Join the community:
Feel free to ask questions in the comments if you need any help or clarification! |
There was a problem hiding this comment.
Pull request overview
Improves documentation consistency and readability across the Kubeflow Trainer SDK by aligning docstrings with common conventions and cleaning up Markdown formatting.
Changes:
- Updated/clarified docstrings in Trainer types and
TrainerClient. - Improved wording for
epochsdocumentation and updated external reference URL. - Adjusted Markdown spacing in
CONTRIBUTING.md(and normalizedCLAUDE.md) for better rendering.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| kubeflow/trainer/types/types.py | Updates LoRA reference URL and clarifies epochs docstring text. |
| kubeflow/trainer/api/trainer_client.py | Docstring punctuation cleanup and minor docstring spacing change. |
| CONTRIBUTING.md | Adds blank lines after headers and removes whitespace-only lines that can affect Markdown rendering. |
| CLAUDE.md | Normalizes file content/formatting. |
VT69
changed the title
VT69
changed the title
VT69
changed the title
|
/ok-to-test |
Thanks for the review! @astefanutti |
| @@ -1 +1 @@ | |||
| AGENTS.md No newline at end of file | |||
| AGENTS.md | |||
There was a problem hiding this comment.
Can you revert changes from this file please?
What this PR does / why we need it:
This PR improves documentation clarity and consistency in the Kubeflow Trainer SDK.
Changes include:
TrainerClient.CONTRIBUTING.mdfor better Markdown readability.These changes improve documentation quality and follow standard Python docstring conventions (PEP 257). No functional changes were made.
Which issue(s) this PR fixes:
N/A
Checklist: